Skip to main content

Guide to Workflow IDE

This guide will provide a more detailed explanation of the components, functionalities, and features in the Digisquares Workflow IDE. Learn how to take full advantage of each section to design, configure, and optimize your workflows.

The Workflow IDE is the interface you use to build workflows. It is made up of four primary areas:

  • Canvas: Arrange blocks and build your workflow.
  • Left Panel: Add blocks and functions, configure triggers, and configure code libraries.
  • Status Bar: Select an environment and debug workflow runs.
  • Toolbar: Rename, run, and deploy a workflow.

Canvas​

The Canvas is the central area of the IDE where you visually design and organize your workflows. It allows for seamless interaction with various workflow nodes, making it intuitive to set up tasks, actions, and conditions.

Step 1: Adding and Connecting Nodes​

  1. Adding Nodes: You can add different nodes to the canvas by dragging them from the left panel. Nodes represent different actions or steps in the workflow.

  2. Connecting Nodes: Once nodes are placed, they can be connected to form a sequence or structure for executing your workflow. Use arrows to connect nodes and define the execution flow.

    Common nodes include:

    • Request: Represents an API request with configurable HTTP methods (GET, POST, etc.).
    • Create Record: A node to insert new records into a system or database.
    • If Condition: Used to implement conditional logic where the flow splits based on a given condition.

Step 2: Configuring Node Properties​

  1. Node Settings: Every node has configurable properties, such as URLs for requests, parameters for actions, and conditions for branching. You can configure these by clicking on the node and editing the properties in the right panel.

  2. Node Properties Examples:

    • For the Request node: Configure the URL, headers, parameters, and method.
    • For the If Condition node: Define the condition to decide the execution path.

Step 3: Locking Nodes​

To prevent accidental changes, you can lock a node. A locked node is indicated by a lock icon, and it cannot be modified unless unlocked. This feature ensures that crucial steps in your workflow are protected.

Left Panel​

The Left Panel is where you manage all the elements that form your workflow. It includes several tabs for handling nodes, variables, constants, global variables, and more.

Step 4: Managing Nodes​

In the Nodes tab, you can access all available nodes that can be added to the workflow. Simply click on any node to add it to the canvas. After adding a node, you can modify its settings and connect it with other nodes.

Step 5: Using Flow Variables​

The Flow Variables tab is where you define variables that are passed throughout the workflow. These variables can be used in requests, responses, or any other dynamic data elements within the workflow.

Request Variables:​

  • Query Parameters: Variables passed in the query string of the URL, used for dynamic data.
  • Path Parameters: Variables embedded directly in the URL path (e.g., /users/{id}).
  • Headers: Custom headers used in requests, such as authentication tokens.

Response Variables:​

  • Status Code: The HTTP status code returned by a request (e.g., 200, 404).
  • Response Data: The data returned in the response from an API or service.

Step 6: Defining Constants​

The Constants tab is for defining immutable values that do not change throughout the workflow. These values can include things like API keys, static URLs, or system identifiers that remain constant across the workflow.

Step 7: Using Global Variables​

Global variables are accessible across the entire workflow. These variables are shared across all nodes and can be accessed or modified at any point in the workflow.

Example Global Variables:​

  • ergtredg: A variable used to store session data.
  • 2 Node: A variable used to store data relevant to a particular node, accessible globally.

Step 8: Configuring Environment Variables​

The Environment Variables tab is used to define environment-specific configurations. This includes settings that change based on whether the workflow is running in development, staging, or production.

Common Environment Variables:​

  • NODE_ENV: Defines the current environment (e.g., development, production).
  • API_BASE_URL: The base URL for API requests, which may change depending on the environment.

Step 9: Using Enum Values​

In the Enum tab, you can define predefined sets of values that will be used in your workflow. For example, you could create an enum for status codes or types of records, ensuring that only valid, predefined values are used in the workflow.

Step 10: Managing Localization​

The Localization tab is for managing multi-language workflows. Here, you can define variables for text that should adapt based on the user's locale. This allows your workflow to be used in different regions or languages.

Status Bar​

The Status Bar at the bottom of the IDE provides real-time information about your workflow. It displays the current environment, execution logs, and provides debugging tools to help you monitor the workflow's progress.

Step 11: Configuring Multiple Environments​

The Status Bar allows you to select the environment where the workflow will run. You can switch between different environments (e.g., development, staging, production) to test and deploy workflows under different conditions.

Key Environment Features:​

  • Environment Selector: Use the status bar to select the environment in which the workflow is running.
  • Environment-Specific Settings: Customize API URLs, authentication keys, and other settings depending on the environment.

Step 12: Debugging and Run History​

The Run History section in the status bar displays the logs of previous executions. This is useful for troubleshooting and debugging issues in your workflow.

Run History Features:​

  • Execution Logs: Track detailed logs of each workflow execution, including request and response data.
  • Errors and Warnings: Display any issues encountered during execution, providing insights into where the workflow failed.

Toolbar​

The Toolbar provides quick access to important workflow management actions. These actions are essential for running, testing, and deploying your workflows.

Step 13: Using Toolbar Features​

  • Run: Executes the workflow immediately, triggering the defined actions in sequence.
  • Deploy: Deploys the workflow so that it runs automatically or on a schedule.
  • Undo/Redo: Revert or reapply any changes made to the workflow, allowing you to experiment with different configurations.
  • Import/Export: Import workflows from external sources or export the current workflow for backup or sharing.

Step 14: Managing Workflow Versions​

The Workflow Management Controls in the toolbar also allow you to:

  • Last Deployed Date: View the date and time the workflow was last deployed.
  • Revert Changes: Undo any changes made since the last deployment.

Conclusion​

The Workflow IDE provides a comprehensive suite of tools to design, configure, and manage complex workflows. By following the steps outlined in this guide, you can fully utilize the features of the IDE, creating efficient and optimized workflows that can be tested and deployed across different environments. The flexibility and ease of use provided by the Workflow IDE will enable you to automate and streamline tasks effectively.